Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add workflow badges to the README #1066

Merged
merged 5 commits into from
Nov 16, 2023

Conversation

tonyandrewmeyer
Copy link
Contributor

Add badges for the Github workflows (except publish) to the README.

These will show when viewing the README in a markdown reader that loads external images (e.g. on Github itself) but more importantly also show the CI status on the Juju releases page.

![Compatibility: DB charms](https://github.com/canonical/operator/actions/workflows/db-charm-tests.yaml/badge.svg)
![Compatibility: Basic charms](https://github.com/canonical/operator/actions/workflows/hello-charm-tests.yaml/badge.svg)
![Compatibility: Observability charms](https://github.com/canonical/operator/actions/workflows/observability-charm-tests.yaml/badge.svg)
![CI Status](https://github.com/canonical/operator/actions/workflows/framework-tests.yaml/badge.svg)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I'm wondering if we really need/want all of these. Maybe just the Charmcraft pack and CI Status ones?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think they are super useful in the README itself. I'm not sure what the aim is with the releases page. @jnsgruk what workflows would you like to see showing up there?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think probably just the ops test workflow and the publish workflow?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, changed!

@jnsgruk jnsgruk merged commit 26c6e95 into canonical:main Nov 16, 2023
19 checks passed
@tonyandrewmeyer tonyandrewmeyer deleted the badge-readme branch November 19, 2023 19:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants